From 76ac46405f687a30e7236d9dd288b821b46a148d Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sun, 14 Jan 2018 17:03:28 -0500 Subject: [PATCH] Update docs for debug cleanup Drop mention of GDK_GL, GDK_VULKAN and GDK_RENDERING_MODE, add docs for GSK_DEBUG and new debug keys that were added. --- docs/reference/gtk/running.sgml | 223 ++++++++++++++++---------------- 1 file changed, 114 insertions(+), 109 deletions(-) diff --git a/docs/reference/gtk/running.sgml b/docs/reference/gtk/running.sgml index 827f7b715b..ebf9851756 100644 --- a/docs/reference/gtk/running.sgml +++ b/docs/reference/gtk/running.sgml @@ -44,10 +44,6 @@ additional environment variables. actions Actions and menu models - - baselines - Show baselines - builder GtkBuilder support @@ -60,10 +56,6 @@ additional environment variables. icontheme Icon themes - - interactive - Open the interactive debugger - keybindings Keybindings @@ -72,10 +64,6 @@ additional environment variables. modules Loading of modules - - no-css-cache - Bypass caching for CSS style properties - printing Printing support @@ -88,13 +76,28 @@ additional environment variables. text Text widget internals + + tree + Tree widget internals + + + A number of keys are influencing behavior instead of just logging: + + + interactive + Open the interactive debugger + + + no-css-cache + Bypass caching for CSS style properties + touchscreen Pretend the pointer is a touchscreen device - tree - Tree widget internals + baselines + Show baselines updates @@ -298,10 +301,6 @@ nevertheless. misc Miscellaneous information - - nograbs - Turn off all pointer and keyboard grabs - frames Information about the frame clock @@ -330,7 +329,46 @@ nevertheless. vulkan Information about Vulkan - + + A number of options affect behavior instead of logging: + + + nograbs + Turn off all pointer and keyboard grabs + + + gl-disable + Disable OpenGL support + + + gl-software + Force OpenGL software rendering + + + gl-texture-rect + Use the OpenGL texture rectangle extension, if available + + + gl-legacy + Use a legacy OpenGL context + + + gl-legacy + Use a GLES OpenGL context + + + vulkan-disable + Disable Vulkan support + + + vulkan-validate + Load the Vulkan validation layer, if available + + + cairo-image + Use image surfaces for cairo rendering. This essentially + turns off all hardware acceleration with the cairo renderer + The special value all can be used to turn on all debug options. The special value help can be used @@ -338,38 +376,65 @@ nevertheless. - - <envar>GDK_RENDERING</envar> + + <envar>GSK_DEBUG</envar> - If set, selects the way how GDK creates similar surfaces. This affects both the - functionality of the function gdk_window_create_similar_surface() as well as the - way GDK creates backing surfaces for double buffering. The following values can - be used: - - - - similar - Create similar surfaces to the window in use. This is the - default behavior when the variable is not set. - - - - image - Always create image surfaces. This essentially turns off - all hardware acceleration inside GTK. - - - - recording - Always create recording surfaces. This causes bare rendering - to the backend without the creation of intermediate surfaces (Pixmaps in X) - and will likely cause flicker. - - - - All other values will be ignored and fall back to the default behavior. More - values might be added in the future. + If GTK+ has been configured with , + this variable can be set to a list of debug options, which cause GSK + to print out different types of debugging information. + + + renderer + General renderer information + + + cairo + cairo renderer information + + + opengl + OpenGL renderer information + + + vulkan + Vulkan renderer information + + + fallback + Information about fallbacks + + + glyphcache + Information about glyph caching + + + A number of options affect behavior instead of logging: + + + geometry + Show borders + + + full-redraw + Force full redraws for every frame + + + sync + Sync after each frame + + + vulkan-staging-image + Use a staging image for Vulkan texture upload + + + vulkan-staging-buffer + Use a staging buffer for Vulkan texture upload + + + The special value all can be used to turn on all + debug options. The special value help can be used + to obtain a list of all supported debug options. @@ -421,66 +486,6 @@ nevertheless. - - <envar>GDK_GL</envar> - - - This variable can be set to a list of options that influence various aspects - of the OpenGL support in GTK+. - - - disable - Disable OpenGL support - - - always - Always use OpenGL for rendering - - - software-draw - Use software rendering - - - texture-rectangle - Use the texture rectangle extension - - - legacy - Use a legacy OpenGL context - - - gles - Use a GLES context - - - The special value all can be used to turn on all - options. The special value help can be used - to obtain a list of all supported options. - - - - - <envar>GDK_VULKAN</envar> - - - This variable can be set to a list of options that influence various aspects - of the Vulkan support in GTK+. - - - disable - Disable Vulkan support - - - validate - Enable the Vulkan validation layer - - - The special value all can be used to turn on all - options. The special value help can be used - to obtain a list of all supported options. - - - <envar>GDK_VULKAN_DEVICE</envar> -- 2.30.2